home *** CD-ROM | disk | FTP | other *** search
/ PC World 2008 September / PCWorld_2008-09_cd.bin / v cisle / sadanastroju / lightning-0.8-tb-win.xpi / chrome / calendar.jar / content / calendar / calendar-alarm-dialog.js < prev    next >
Encoding:
JavaScript  |  2007-12-10  |  10.3 KB  |  288 lines
  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3.  *
  4.  * The contents of this file are subject to the Mozilla Public License Version
  5.  * 1.1 (the "License"); you may not use this file except in compliance with
  6.  * the License. You may obtain a copy of the License at
  7.  * http://www.mozilla.org/MPL/
  8.  *
  9.  * Software distributed under the License is distributed on an "AS IS" basis,
  10.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11.  * for the specific language governing rights and limitations under the
  12.  * License.
  13.  *
  14.  * The Original Code is Oracle Corporation code.
  15.  *
  16.  * The Initial Developer of the Original Code is Oracle Corporation
  17.  * Portions created by the Initial Developer are Copyright (C) 2005
  18.  * the Initial Developer. All Rights Reserved.
  19.  *
  20.  * Contributor(s):
  21.  *   Stuart Parmenter <stuart.parmenter@oracle.com>
  22.  *   Philipp Kewisch <mozilla@kewis.ch>
  23.  *   Daniel Boelzle <daniel.boelzle@sun.com>
  24.  *
  25.  * Alternatively, the contents of this file may be used under the terms of
  26.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28.  * in which case the provisions of the GPL or the LGPL are applicable instead
  29.  * of those above. If you wish to allow use of your version of this file only
  30.  * under the terms of either the GPL or the LGPL, and not to allow others to
  31.  * use your version of this file under the terms of the MPL, indicate your
  32.  * decision by deleting the provisions above and replace them with the notice
  33.  * and other provisions required by the GPL or the LGPL. If you do not delete
  34.  * the provisions above, a recipient may use your version of this file under
  35.  * the terms of any one of the MPL, the GPL or the LGPL.
  36.  *
  37.  * ***** END LICENSE BLOCK ***** */
  38.  
  39. /**
  40.  * Helper function to get the alarm service and cache it.
  41.  *
  42.  * @return The alarm service component
  43.  */
  44. function getAlarmService() {
  45.     if (!window.mAlarmService) {
  46.         window.mAlarmService = Components.classes["@mozilla.org/calendar/alarm-service;1"]
  47.                                          .getService(Components.interfaces.calIAlarmService);
  48.     }
  49.     return window.mAlarmService;
  50. }
  51.  
  52. /**
  53.  * Event handler for the 'snooze' event. Snoozes the given alarm by the given
  54.  * number of minutes using the alarm service.
  55.  *
  56.  * @param event     The snooze event
  57.  */
  58. function onSnoozeAlarm(event) {
  59.     // reschedule alarm:
  60.     var duration = Components.classes["@mozilla.org/calendar/duration;1"]
  61.                              .createInstance(Components.interfaces.calIDuration);
  62.     duration.minutes = event.detail;
  63.     duration.normalize();
  64.     getAlarmService().snoozeAlarm(event.target.item, duration);
  65. }
  66.  
  67. /**
  68.  * Event handler for the 'dismiss' event. Dismisses the given alarm using the
  69.  * alarm service.
  70.  *
  71.  * @param event     The snooze event
  72.  */
  73. function onDismissAlarm(event) {
  74.     getAlarmService().dismissAlarm(event.target.item);
  75. }
  76.  
  77. /**
  78.  * Called to dismiss all alarms in the alarm window.
  79.  */
  80. function onDismissAllAlarms() {
  81.     // removes widgets on the fly:
  82.     var alarmRichlist = document.getElementById("alarm-richlist");
  83.     for (var i = alarmRichlist.childNodes.length - 1; i >= 0; i--) {
  84.         if (alarmRichlist.childNodes[i].item) {
  85.             getAlarmService().dismissAlarm(alarmRichlist.childNodes[i].item);
  86.         }
  87.     }
  88. }
  89.  
  90. /**
  91.  * Event handler fired when the alarm widget's "Details..." label was clicked.
  92.  * Open the event dialog in the most recent sunbird or thunderbird window
  93.  *
  94.  * @param event     The itemdetails event.
  95.  */
  96. function onItemDetails(event) {
  97.     // We want this to happen in a calendar window.
  98.     var wm = Components.classes["@mozilla.org/appshell/window-mediator;1"]
  99.                        .getService(Components.interfaces.nsIWindowMediator);
  100.     var calWindow = wm.getMostRecentWindow("calendarMainWindow") ||
  101.                     wm.getMostRecentWindow("mail:3pane");
  102.     var item = calWindow.getOccurrenceOrParent(event.target.item);
  103.     calWindow.modifyEventWithDialog(item);
  104. }
  105.  
  106. /**
  107.  * Sets up the alarm dialog, initializing the default snooze length and setting
  108.  * up the relative date update timer.
  109.  */
  110. var gRelativeDateUpdateTimer;
  111. function setupWindow() {
  112.     // We want to update when we are at 0 seconds past the minute. To do so, use
  113.     // setTimeout to wait until we are there, then setInterval to exectue every
  114.     // minute. Since setInterval is not totally exact, we may run into problems
  115.     // here. I hope not!
  116.     var current = new Date();
  117.  
  118.     var timeout = (60 - current.getSeconds()) * 1000;
  119.     gRelativeDateUpdateTimer = setTimeout(function wait_until_next_minute() {
  120.         updateRelativeDates();
  121.         gRelativeDateUpdateTimer = setInterval(updateRelativeDates, 60 * 1000);
  122.     }, timeout);
  123.  
  124.     // Give focus to the alarm richlist after onload completes. see bug 103197
  125.     setTimeout(onFocusWindow, 0);
  126. }
  127.  
  128. /**
  129.  * Unload function for the alarm dialog. If applicable, snooze the remaining
  130.  * alarms and clean up the relative date update timer.
  131.  */
  132. function finishWindow() {
  133.     var alarmRichlist = document.getElementById("alarm-richlist");
  134.  
  135.     if (alarmRichlist.childNodes.length > 0) {
  136.         // If there are still items, the window wasn't closed using dismiss
  137.         // all/snooze all. This can happen when the closer is clicked or escape
  138.         // is pressed. Snooze all remaining items using the default snooze
  139.         // property.
  140.         var snoozePref = getPrefSafe("calendar.alarms.defaultsnoozelength", 0);
  141.         if (snoozePref <= 0) {
  142.             snoozePref = 5;
  143.         }
  144.         snoozeAllItems(snoozePref);
  145.     }
  146.  
  147.     // Stop updating the relative time
  148.     clearTimeout(gRelativeDateUpdateTimer);
  149. }
  150.  
  151. /**
  152.  * Set up the focused element. If no element is focused, then switch to the
  153.  * richlist.
  154.  */
  155. function onFocusWindow() {
  156.     if (!document.commandDispatcher.focusedElement) {
  157.         document.getElementById("alarm-richlist").focus();
  158.     }
  159. }
  160.  
  161. /**
  162.  * Timer callback to update all relative date labels
  163.  */
  164. function updateRelativeDates() {
  165.     var alarmRichlist = document.getElementById("alarm-richlist");
  166.     for (var i = alarmRichlist.childNodes.length - 1; i >= 0; i--) {
  167.         if (alarmRichlist.childNodes[i].item) {
  168.             alarmRichlist.childNodes[i].updateRelativeDateLabel();
  169.         }
  170.     }
  171. }
  172.  
  173. /**
  174.  * Opens the alarm snooze popup, using the event to determine the position.
  175.  * The given container item must be an object that has a function snoozeAlarm.
  176.  * This function will be called with the chosen alarm duration in minutes.
  177.  *
  178.  * @param event           The event used to determine the position of the popup
  179.  * @param aContainerItem  The container item as described above
  180.  */
  181. function openSnoozeWindow(event, aContainerItem) {
  182.     const uri = "chrome://calendar/content/calendar-alarm-snooze-popup.xul";
  183.     var pos = ",left=" + (event.target.boxObject.screenX - 3) +
  184.              ",top=" + (event.target.boxObject.screenY + event.target.boxObject.height - 3);
  185. //@line 194 "/cygdrive/c/builds/tinderbox/Lt-Mozilla1.8/WINNT_5.2_Depend/mozilla/calendar/lightning/../base/content/calendar-alarm-dialog.js"
  186.     window.openDialog(uri,
  187.                       uri,
  188.                       "chrome,dependent=yes,titlebar=no" + pos,
  189.                       aContainerItem);
  190. }
  191.  
  192. /**
  193.  * Function to snooze all alarms the given number of minutes.
  194.  *
  195.  * @param aDurationMinutes    The duration in minutes
  196.  */
  197. function snoozeAllItems(aDurationMinutes) {
  198.     var duration = Components.classes["@mozilla.org/calendar/duration;1"]
  199.                              .createInstance(Components.interfaces.calIDuration);
  200.     duration.minutes = aDurationMinutes;
  201.     duration.normalize();
  202.  
  203.     var alarmRichlist = document.getElementById("alarm-richlist");
  204.     for (var i = alarmRichlist.childNodes.length - 1; i >= 0; i--) {
  205.         if (alarmRichlist.childNodes[i].item) {
  206.             getAlarmService().snoozeAlarm(alarmRichlist.childNodes[i].item, duration);
  207.         }
  208.     }
  209. }
  210.  
  211. /**
  212.  * Sets up the window title, counting the number of alarms in the window.
  213.  */
  214. function setupTitle() {
  215.     var alarmRichlist = document.getElementById("alarm-richlist");
  216.     var reminders = alarmRichlist.childNodes.length;
  217.  
  218.     document.title = calGetString("calendar", "alarmWindowTitle", [reminders]);
  219. }
  220.  
  221. /**
  222.  * Add an alarm widget for the passed calendar item
  223.  *
  224.  * @param aItem       The calendar item to add a widget for.
  225.  */
  226. function addWidgetFor(aItem) {
  227.     var widget = document.createElement("calendar-alarm-widget");
  228.     var alarmRichlist = document.getElementById("alarm-richlist");
  229.     alarmRichlist.appendChild(widget);
  230.  
  231.     widget.item = aItem;
  232.     widget.addEventListener("snooze", onSnoozeAlarm, false);
  233.     widget.addEventListener("dismiss", onDismissAlarm, false);
  234.     widget.addEventListener("itemdetails", onItemDetails, false);
  235.  
  236.     setupTitle();
  237.  
  238.     if (alarmRichlist.selectedIndex < 0) {
  239.         alarmRichlist.selectedIndex = 0;
  240.     }
  241.  
  242.     window.focus();
  243.     window.getAttention();
  244. }
  245.  
  246. /**
  247.  * Remove the alarm widget for the passed calendar item
  248.  *
  249.  * @param aItem       The calendar item to remove the alarm widget for.
  250.  */
  251. function removeWidgetFor(aItem) {
  252.     var hashId = aItem.hashId;
  253.     var alarmRichlist = document.getElementById("alarm-richlist");
  254.     var nodes = alarmRichlist.childNodes;
  255.     for (var i = nodes.length - 1; i >= 0; --i) {
  256.         var widget = nodes[i];
  257.         if (widget.item && widget.item.hashId == hashId) {
  258.  
  259.             if (widget.selected) {
  260.                 // Advance selection if needed
  261.                 widget.control.selectedItem = widget.previousSibling ||
  262.                                               widget.nextSibling;
  263.             }
  264.  
  265.             widget.removeEventListener("snooze", onSnoozeAlarm, false);
  266.             widget.removeEventListener("dismiss", onDismissAlarm, false);
  267.             widget.removeEventListener("itemdetails", onItemDetails, false);
  268.             alarmRichlist.removeChild(widget);
  269.  
  270.             if (!alarmRichlist.hasChildNodes()) {
  271.                 // check again next round since this removeWidgetFor call may be
  272.                 // followed by an addWidgetFor call (e.g. when refreshing), and
  273.                 // we don't want to close and open the window in that case.
  274.                 function closer() {
  275.                     if (!alarmRichlist.hasChildNodes()) {
  276.                         window.close();
  277.                     }
  278.                 }
  279.                 setTimeout(closer, 0);
  280.             }
  281.             break;
  282.         }
  283.     }
  284.  
  285.     // Update the title
  286.     setupTitle();
  287. }
  288.